Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ogma-cli: Allow customizing the cFS application template. Refs #157. #160

Merged
merged 6 commits into from
Nov 14, 2024

Conversation

ivanperez-keera
Copy link
Member

Adjust ogma-cli and ogma-core to allow customizing the cFS application by using custom-provided templates, as prescribed in the solution proposed for #157.

@ivanperez-keera
Copy link
Member Author

ivanperez-keera commented Nov 14, 2024

Change Manager: The functions fileContents could be renamed, the comment needs to be adjusted, and the haddock for copyTemplate needs to provide more details.

…ion. Refs nasa#157.

The cFS application generation backend has a fixed template that it uses
to generate the cFS application. That template does not fit all use
cases, so we are finding users heavily modifying the output (which is
hard to keep up with when there are changes), and or not using ogma
altogether for that reason.

This commit modifies the ogma-core cfs command to use mustache to
generate the cFS monitoring application template using variable
expansion.
…n. Refs nasa#157.

The cFS application generation backend has a fixed template that it uses
to generate the cFS application. That template does not fit all use
cases, so we are finding users heavily modifying the output (which is
hard to keep up with when there are changes), and or not using ogma
altogether for that reason.

A recent commit introduced the ability to use mustache to expand
variables in a template. This commit modifies the cfs command to accept
an additional argument that points to a user-provided directory with a
custom template.
…irectory to cFS app command. Refs nasa#157.

The cFS application generation backend has a fixed template that it uses
to generate the cFS application. That template does not fit all use
cases, so we are finding users heavily modifying the output (which is
hard to keep up with when there are changes), and or not using ogma
altogether for that reason.

A recent commit introduced into ogma-core the ability to use a custom
provided template and expand variables using mustache.

This commit exposes that new parameter to the user in the CLI.
…ation. Refs nasa#157.

The cFS application generation backend has a fixed template that it uses
to generate the cFS application. That template does not fit all use
cases, so we are finding users heavily modifying the output (which is
hard to keep up with when there are changes), and or not using ogma
altogether for that reason.

Prior commits have expanded the command to allow for customization of
the template using a user-provided directory and expanding variables
in the template using mustache.

This commit documents the new feature in the README.
@ivanperez-keera
Copy link
Member Author

Implementor: Updates implemented, review requested.

@ivanperez-keera
Copy link
Member Author

ivanperez-keera commented Nov 14, 2024

Change Manager: Verified that:

  • Solution is implemented:
    • The code proposed compiles and passes all tests. Details:
    • The solution proposed produces the expected result. Details:
      The following dockerfile generates the cFS application using the default template and using a copy and the default template and checks that both are the same. It then adds a file to the copy of the template and checks that the file is copied to the target directory when the custom template is used, after which it prints the message "Success".
      FROM ubuntu:trusty
      
      ENV DEBIAN_FRONTEND=noninteractive
      
      RUN apt-get update
      
      RUN apt-get install --yes software-properties-common
      RUN add-apt-repository ppa:hvr/ghc
      RUN apt-get update
      
      RUN apt-get install --yes ghc-8.6.5 cabal-install-2.4
      RUN apt-get install --yes libz-dev
      
      ENV PATH=/opt/ghc/8.6.5/bin:/opt/cabal/2.4/bin:$PWD/.cabal-sandbox/bin:$PATH
      
      RUN cabal update
      RUN cabal v1-sandbox init
      RUN cabal v1-install alex happy
      RUN apt-get install --yes git
      
      CMD git clone $REPO && \
          cd $NAME && \
          git checkout $COMMIT && \
          cd .. && \
          cabal v1-install $NAME/$PAT**/ --constraint="aeson>=2.0.3.0"                              && \
          cp -r $NAME/ogma-core/templates/copilot-cfs custom-template-cfs                           && \
          find custom-template-cfs -iname '.gitignore' -delete                                      && \
          ./.cabal-sandbox/bin/ogma cfs --variable-file $NAME/ogma-cli/examples/cfs-variables --variable-db $NAME/ogma-cli/examples/cfs-variable-db --app-target-dir original                                   && \
          ./.cabal-sandbox/bin/ogma cfs --variable-file $NAME/ogma-cli/examples/cfs-variables --variable-db $NAME/ogma-cli/examples/cfs-variable-db --app-target-dir new --app-template-dir custom-template-cfs && \
          diff -rq original new                                                                     && \
          rm -rf new                                                                                && \
          echo "Success" >> custom-template-cfs/test                                                && \
          ./.cabal-sandbox/bin/ogma cfs --variable-file $NAME/ogma-cli/examples/cfs-variables --variable-db $NAME/ogma-cli/examples/cfs-variable-db --app-target-dir new --app-template-dir custom-template-cfs && \
          cat new/test
      Command (substitute variables based on new path after merge):
      $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e "PAT=ogma"  -e "COMMIT=a1a96818e5a60420c233a3a00d4117e95dfbb1b0" -it ogma-verify-157
      
  • Implementation is documented. Details:
    The new code has comments.
  • Change history is clear.
  • Commit messages are clear.
  • Changelogs are updated.
  • Examples are updated. Details:
    No updates needed.
  • Required version bumps are evaluated. Details:
    No bump needed. New feature is backwards compatible.

@ivanperez-keera ivanperez-keera merged commit 75f03d9 into nasa:develop Nov 14, 2024
2 checks passed
@ivanperez-keera ivanperez-keera deleted the develop-cfs-templates branch November 14, 2024 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant